System APIs

Description

Defines how a RamBase object type is rendered for output, covering format, email, FTP, and print delivery settings.

Tags and resources

Email settings

Email delivery settings for automated output distribution.

FTP settings

FTP destination settings for automated document delivery.

Output Format

The file format (e.g. PDF, CSV, XML) used when generating output for this object definition.

Print settings

Print-specific delivery settings for an output object definition.

POST

system/output-object-definitions

Creates a new output object definition

GET

system/output-object-definitions

List of output object definitions

POST

system/output-object-definitions/api-operations/{apiOperationId}/instances

1 operation(s) for system/output-object-definitions

PUT

system/output-object-definitions/{outputObjectDefinitionId}

Update provided output object definition

GET

system/output-object-definitions/{outputObjectDefinitionId}

Output object definition details for the provided identifier

POST

system/output-object-definitions/{outputObjectDefinitionId}/api-operations/{apiOperationId}/instances

4 operation(s) for system/output-object-definitions/{outputObjectDefinitionId}

DELETE

system/output-object-definitions/{outputObjectDefinitionId}

Remove output object definition

PUT

system/output-object-definitions/{outputObjectDefinitionId}/email-settings

Creates a new email media for the given output object definition

GET

system/output-object-definitions/{outputObjectDefinitionId}/email-settings

This is the email settings for the provided output object definition set by the customer.

POST

system/output-object-definitions/{outputObjectDefinitionId}/email-settings/api-operations/{apiOperationId}/instances

6 operation(s) for system/output-object-definitions/{outputObjectDefinitionId}/email-settings

GET

system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults

Email settings for the provided output object definition

PUT

system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults

Update email settings for provided output object definition

GET

system/output-object-definitions/{outputObjectDefinitionId}/output-designs

Makes it possible to get all designs available for a given output object definition

PUT

system/output-object-definitions/{outputObjectDefinitionId}/print-settings

Creates a new print media for the given output object definition

GET

system/output-object-definitions/{outputObjectDefinitionId}/print-settings

This is the print settings for the provided output object definition set by the customer.

POST

system/output-object-definitions/{outputObjectDefinitionId}/print-settings/api-operations/{apiOperationId}/instances

5 operation(s) for system/output-object-definitions/{outputObjectDefinitionId}/print-settings

PUT

system/output-object-definitions/{outputObjectDefinitionId}/print-settings/defaults

Update print settings for provided output object definition

GET

system/output-object-definitions/{outputObjectDefinitionId}/print-settings/defaults

Print Settings for the Output object definition of the provided identifier

GET

system/output-object-definitions/applicable-output-object-definitions

List of applicable output object definitions